home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 2: Applications / Linux Cubed Series 2 - Applications.iso / editors / emacs / xemacs / xemacs-1.004 / xemacs-1 / xemacs-19.13 / src / window.h < prev    next >
Encoding:
C/C++ Source or Header  |  1995-08-26  |  15.5 KB  |  398 lines
  1. /* Window definitions for XEmacs.
  2.    Copyright (C) 1985, 1986, 1992, 1993, 1994 Free Software Foundation, Inc.
  3.    Copyright (C) 1994, 1995 Board of Trustees, University of Illinois
  4.  
  5. This file is part of XEmacs.
  6.  
  7. XEmacs is free software; you can redistribute it and/or modify it
  8. under the terms of the GNU General Public License as published by the
  9. Free Software Foundation; either version 2, or (at your option) any
  10. later version.
  11.  
  12. XEmacs is distributed in the hope that it will be useful, but WITHOUT
  13. ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14. FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15. for more details.
  16.  
  17. You should have received a copy of the GNU General Public License
  18. along with XEmacs; see the file COPYING.  If not, write to the Free
  19. Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
  20.  
  21. /* Synched up with: FSF 19.28. */
  22.  
  23. #ifndef _XEMACS_WINDOW_H_
  24. #define _XEMACS_WINDOW_H_
  25.  
  26. #include "redisplay.h"
  27. #include "scrollbar.h"
  28.  
  29. /* All windows in use are arranged into a tree, with pointers up and down.
  30.  
  31. Windows that are leaves of the tree are actually displayed
  32. and show the contents of buffers.  Windows that are not leaves
  33. are used for representing the way groups of leaf windows are
  34. arranged on the frame.  Leaf windows never become non-leaves.
  35. They are deleted only by calling delete-window on them (but
  36. this can be done implicitly).  Combination windows can be created
  37. and deleted at any time.
  38.  
  39. A leaf window has a non-nil buffer field, and also
  40.  has markers in its start and pointm fields.  Non-leaf windows
  41.  have nil in these fields.
  42.  
  43. Non-leaf windows are either vertical or horizontal combinations.
  44.  
  45. A vertical combination window has children that are arranged on the frame
  46. one above the next.  Its vchild field points to the uppermost child.
  47. The parent field of each of the children points to the vertical
  48. combination window.  The next field of each child points to the
  49. child below it, or is nil for the lowest child.  The prev field
  50. of each child points to the child above it, or is nil for the
  51. highest child.
  52.  
  53. A horizontal combination window has children that are side by side.
  54. Its hchild field points to the leftmost child.  In each child
  55. the next field points to the child to the right and the prev field
  56. points to the child to the left.
  57.  
  58. The children of a vertical combination window may be leaf windows
  59. or horizontal combination windows.  The children of a horizontal
  60. combination window may be leaf windows or vertical combination windows.
  61.  
  62. At the top of the tree are two windows which have nil as parent.
  63. The second of these is minibuf_window.  The first one manages all
  64. the frame area that is not minibuffer, and is called the root window.
  65. Different windows can be the root at different times;
  66. initially the root window is a leaf window, but if more windows
  67. are created then that leaf window ceases to be root and a newly
  68. made combination window becomes root instead.
  69.  
  70. In any case, on screens which have an ordinary window and a
  71. minibuffer, prev of the minibuf window is the root window and next of
  72. the root window is the minibuf window.  On minibufferless screens or
  73. minibuffer-only screens, the root window and the minibuffer window are
  74. one and the same, so its prev and next members are nil.
  75.  
  76. A dead window has the `dead' flag set on it.  Note that unlike other
  77. dead objects, dead windows can be made live again through restoring a
  78. window configuration.  This means that the values in a dead window
  79. need to be preserved, except for those that are reconstructed by from
  80. the window configuration. */
  81.  
  82. struct window
  83. {
  84.   struct lcrecord_header header;
  85.  
  86.   /* The frame this window is on.  */
  87.   Lisp_Object frame;
  88.   /* t if this window is a minibuffer window.  */
  89.   Lisp_Object mini_p;
  90.   /* Following child (to right or down) at same level of tree */
  91.   Lisp_Object next;
  92.   /* Preceding child (to left or up) at same level of tree */
  93.   Lisp_Object prev;
  94.   /* First child of this window. */
  95.   /* vchild is used if this is a vertical combination,
  96.      hchild if this is a horizontal combination. */
  97.   Lisp_Object hchild, vchild;
  98.   /* The window this one is a child of. */
  99.   Lisp_Object parent;
  100.  
  101.   /* The upper left corner coordinates of this window,
  102.      as integers (pixels) relative to upper left corner of frame = 0, 0 */
  103.   int pixel_left;
  104.   int pixel_top;
  105.   /* The size of the window (in pixels) */
  106.   int pixel_height;
  107.   int pixel_width;
  108.  
  109.   /* The buffer displayed in this window */
  110.   /* Of the fields vchild, hchild and buffer, only one is non-nil.  */
  111.   Lisp_Object buffer;
  112.   /* A marker pointing to where in the text to start displaying */
  113.   /* need one for each set of display structures */
  114.   Lisp_Object start[3];
  115.   /* A marker pointing to where in the text point is in this window,
  116.      used only when the window is not selected.
  117.      This exists so that when multiple windows show one buffer
  118.      each one can have its own value of point.  */
  119.   /* need one for each set of display structures */
  120.   Lisp_Object pointm[3];
  121.   /* A marker pointing to where in the text the scrollbar is pointing */
  122.   Lisp_Object sb_point;
  123.   /* Number of columns display within the window is scrolled to the left. */
  124.   int hscroll;
  125.   /* Number saying how recently window was selected */
  126.   Lisp_Object use_time;
  127.   /* text.modified of displayed buffer as of last time display completed */
  128.   Lisp_Object last_modified[3];
  129.   /* Value of point at that time */
  130.   Lisp_Object last_point[3];
  131.   /* Value of start at that time */
  132.   Lisp_Object last_start[3];
  133.   /* buf.face_change as of last time display completed */
  134.   Lisp_Object last_facechange[3];
  135.  
  136.   /* face cache elements correct for this window and its current buffer */
  137.   face_cache_element_dynarr *face_cache_elements;
  138.   /* glyph cache elements correct for this window and its current buffer */
  139.   glyph_cache_element_dynarr *glyph_cache_elements;
  140.  
  141.  
  142.   /* List of starting positions for display lines.  Only valid if
  143.      buffer has not changed. */
  144.   line_start_cache_dynarr *line_start_cache;
  145.   Lisp_Object line_cache_last_updated;
  146.   int line_cache_validation_override;
  147.  
  148.   /* Length of longest line currently displayed.  Used to control the
  149.      width of the horizontal scrollbars. */
  150.   int max_line_len;
  151.  
  152.   /* Frame coords of point at that time */
  153.   int last_point_x[3];
  154.   int last_point_y[3];
  155.  
  156.   /* Number of characters in buffer past bottom of window,
  157.      as of last redisplay that finished. */
  158.   /* need one for each set of display structures */
  159.   int window_end_pos[3];
  160.  
  161.   /* Non-nil means window is marked as dedicated.  */
  162.   Lisp_Object dedicated;
  163.   /* Display-table to use for displaying chars in this window.
  164.      Nil means use the buffer's own display-table.  */
  165.   Lisp_Object display_table;
  166.  
  167.   /* specifier values cached in the struct window: */
  168.  
  169.   /* Thickness of modeline shadow, in pixels.  If negative, draw
  170.      as recessed. */
  171.   Lisp_Object modeline_shadow_thickness;
  172.   /* Non-nil means to display a modeline for the buffer. */
  173.   Lisp_Object has_modeline_p;
  174.   /* Width of vertical scrollbars. */
  175.   Lisp_Object scrollbar_width;
  176.   /* Height of horizontal scrollbars. */
  177.   Lisp_Object scrollbar_height;
  178.   /* #### Window-local toolbars don't exist yet. */
  179.   Lisp_Object toolbar_size[4];
  180.   Lisp_Object left_margin_width, right_margin_width;
  181.   Lisp_Object minimum_line_ascent, minimum_line_descent;
  182.   Lisp_Object use_left_overflow, use_right_overflow;
  183.   /* Visibility of menubar. */
  184.   Lisp_Object menubar_visible_p;
  185.   /* Caption status of toolbar. */
  186.   Lisp_Object toolbar_buttons_captioned_p;
  187.  
  188.   /* one-bit flags: */
  189.  
  190.   /* marker used when restoring a window configuration */
  191.   unsigned int config_mark :1;
  192.   /* Non-zero means window was dead. */
  193.   unsigned int dead :1;
  194.   /* Non-zero means next redisplay must use the value of start
  195.      set up for it in advance.  Set by scrolling commands.  */
  196.   unsigned int force_start :1;
  197.   /* Non-zero means must regenerate modeline of this window */
  198.   unsigned int redo_modeline :1;
  199.   /* Non-zero means current value of `start'
  200.      was the beginning of a line when it was chosen.  */
  201.   unsigned int start_at_line_beg :1;
  202.   /* new redisplay flag */
  203.   unsigned int windows_changed :1;
  204.   unsigned int shadow_thickness_changed :1;
  205.   };
  206.  
  207. #define CURRENT_DISP        0
  208. #define DESIRED_DISP        1
  209. #define CMOTION_DISP        2
  210.  
  211. struct window_mirror
  212. {
  213.   /* Frame this mirror is on. */
  214.   struct frame *frame;
  215.  
  216.   /* Following child (to right or down) at same level of tree */
  217.   struct window_mirror *next;
  218.  
  219.   /* There is no prev field because we never traverse this structure
  220.      backwards.  Same goes for the parent field. */
  221.  
  222.   /* First child of this window. */
  223.   /* vchild is used if this is a vertical combination,
  224.      hchild if this is a horizontal combination. */
  225.   struct window_mirror *hchild, *vchild;
  226.  
  227.   /* Dynamic array of display lines */
  228.   display_line_dynarr *current_display_lines;
  229.   display_line_dynarr *desired_display_lines;
  230.   display_line_dynarr *cmotion_display_lines;
  231.  
  232.   /* Buffer current_display_lines represent. */
  233.   struct buffer *buffer;
  234.  
  235.   /* Scrollbars associated with window, if any. */
  236.   struct scrollbar_instance *scrollbar_vertical_instance;
  237.   struct scrollbar_instance *scrollbar_horizontal_instance;
  238.  
  239.   /* Flag indicating whether a subwindow is currently being displayed. */
  240.   int subwindows_being_displayed :1;
  241.  
  242.   /* Keep track of the truncation status in this window so we can
  243.      detect when it has changed.  #### Magic variables would be a huge
  244.      win here. */
  245.   int truncate_win :1;
  246. };
  247.  
  248. #ifdef emacs  /* some things other than emacs want the structs */
  249.  
  250. DECLARE_LRECORD (window, struct window);
  251. #define XWINDOW(x) XRECORD (x, window, struct window)
  252. #define XSETWINDOW(x, p) XSETRECORD (x, p, window)
  253. #define WINDOWP(x) RECORDP (x, window)
  254. #define CHECK_WINDOW(x, i) CHECK_RECORD (x, window)
  255.  
  256. extern Lisp_Object Qwindow_live_p;
  257.  
  258. #define WINDOW_LIVE_P(x) (!(x)->dead)
  259. #define CHECK_LIVE_WINDOW(x, i)                        \
  260.   do { CHECK_WINDOW (x, i);                        \
  261.        if (!WINDOWP (x) ||                        \
  262.        ! WINDOW_LIVE_P (XWINDOW (x)))                \
  263.      x = wrong_type_argument (Qwindow_live_p, (x));            \
  264.      } while (0)
  265.  
  266. /* 1 if W is a minibuffer window.  */
  267. #define MINI_WINDOW_P(W)  (!EQ ((W)->mini_p, Qnil))
  268.  
  269. /* 1 if we are dealing with a parentless window (this includes the
  270.    root window on a frame and the minibuffer window; both of these
  271.    are siblings). */
  272. #define TOP_LEVEL_WINDOW_P(w) NILP ((w)->parent)
  273.  
  274. /* Set all redisplay flags indicating a window has changed */
  275. #define MARK_WINDOWS_CHANGED(w) do {                    \
  276.   (w)->windows_changed = 1;                        \
  277.   if (!NILP (w->frame))                            \
  278.     MARK_FRAME_WINDOWS_CHANGED (XFRAME (w->frame));            \
  279.   else                                    \
  280.     windows_changed = 1; } while (0)
  281.  
  282. #define WINDOW_IS_TTY(w) FRAME_IS_TTY (XFRAME ((w)->frame))
  283. #define WINDOW_IS_X(w) FRAME_IS_X (XFRAME ((w)->frame))
  284. #define WINDOW_IS_NS(w) FRAME_IS_NS (XFRAME ((w)->frame))
  285. #define WINDOW_IS_WIN(w) FRAME_IS_WIN (XFRAME ((w)->frame))
  286.  
  287. /* The minibuffer window of the selected frame.
  288.    Note that you cannot test for minibufferness of an arbitrary window
  289.    by comparing against this; but you can test for minibufferness of
  290.    the selected window or of any window that is displayed.  */
  291. extern Lisp_Object minibuf_window;
  292.  
  293. /* Non-nil => window to for C-M-v to scroll
  294.    when the minibuffer is selected.  */
  295. extern Lisp_Object Vminibuf_scroll_window;
  296.  
  297. /* Prompt to display in front of the minibuffer contents, or nil */
  298. extern Lisp_Object Vminibuf_prompt;
  299.  
  300. /* Depth in minibuffer invocations */
  301. extern int minibuf_level;
  302.  
  303. /* Maximum hscroll value horizontal scrollbar can represent. */
  304. extern int max_hscrollbar_width;
  305.  
  306. extern Lisp_Object allocate_window (void);
  307. extern int window_char_width (struct window *, int include_margins_p);
  308. extern int window_char_height (struct window *, int include_modeline_p);
  309. extern int window_displayed_height (struct window *);
  310. extern int window_is_leftmost (struct window *w);
  311. extern int window_is_rightmost (struct window *w);
  312. extern int window_truncation_on (struct window *w);
  313. extern int window_needs_vertical_divider (struct window *);
  314. extern int window_scrollbar_width (struct window *w);
  315. extern int window_scrollbar_height (struct window *w);
  316. extern int window_modeline_height (struct window *w);
  317. extern int window_left_margin_width (struct window *w);
  318. extern int window_right_margin_width (struct window *w);
  319. extern int window_top_gutter_height (struct window *w);
  320. extern int window_bottom_gutter_height (struct window *w);
  321. extern int window_left_gutter_width (struct window *w, int modeline);
  322. extern int window_right_gutter_width (struct window *w, int modeline);
  323. extern int window_bottom_toolbar_height (struct window *w);
  324.  
  325. extern void delete_all_subwindows (struct window *w);
  326. extern void set_window_pixheight (Lisp_Object window, int pixheight,
  327.                   int nodelete);
  328. extern void set_window_pixwidth (Lisp_Object window, int pixwidth,
  329.                  int nodelete);
  330. extern void window_scroll (Lisp_Object window, Lisp_Object n, int direction,
  331.                int no_error);
  332. extern int buffer_window_count (struct buffer *b, struct frame *f);
  333. extern int buffer_window_mru (struct window *w);
  334. extern void check_frame_size (struct frame *frame, int *rows, int *cols);
  335. extern void mark_windows_in_use (Lisp_Object window, int mark);
  336. extern struct window *decode_window (Lisp_Object window);
  337. extern struct window *find_window_by_pixel_pos (unsigned int pix_x,
  338.                         unsigned int pix_y,
  339.                         Lisp_Object win);
  340.  
  341. /* new functions to handle the window mirror */
  342. extern void free_window_mirror (struct window_mirror *mir);
  343. extern Lisp_Object real_window (struct window_mirror *mir, int no_abort);
  344. extern struct window_mirror *find_window_mirror (struct window *w);
  345. extern display_line_dynarr *window_display_lines (struct window *w, int);
  346. extern struct buffer *window_display_buffer (struct window *w);
  347. extern void set_window_display_buffer (struct window *w, struct buffer *b);
  348. extern void update_frame_window_mirror (struct frame *f);
  349.  
  350. extern int map_windows (struct frame *f,
  351.             int (*mapfun) (struct window *w, void *closure),
  352.             void *closure);
  353. extern void some_window_value_changed (Lisp_Object specifier, struct window *w,
  354.                        Lisp_Object oldval);
  355.  
  356. #define WINDOW_FRAME(w) ((w)->frame)
  357. #define WINDOW_BUFFER(w) ((w)->buffer)
  358.  
  359. /* XEmacs window size and positioning macros. */
  360. #define WINDOW_TOP(w) ((w)->pixel_top)
  361. #define WINDOW_TEXT_TOP(w) (WINDOW_TOP (w) + window_top_gutter_height (w))
  362. #define WINDOW_BOTTOM(w) ((w)->pixel_top + (w)->pixel_height)
  363. #define WINDOW_TEXT_BOTTOM(w) (WINDOW_BOTTOM (w) - window_bottom_gutter_height (w))
  364. #define WINDOW_LEFT(w) ((w)->pixel_left)
  365. #define WINDOW_TEXT_LEFT(w) (WINDOW_LEFT (w) + window_left_gutter_width (w, 0))
  366. #define WINDOW_MODELINE_LEFT(w)    \
  367.   (WINDOW_LEFT (w) + window_left_gutter_width (w, 1))
  368. #define WINDOW_RIGHT(w) ((w)->pixel_left + (w)->pixel_width)
  369. #define WINDOW_TEXT_RIGHT(w)    \
  370.   (WINDOW_RIGHT (w) - window_right_gutter_width (w, 0))
  371. #define WINDOW_MODELINE_RIGHT(w)    \
  372.   (WINDOW_RIGHT (w) - window_right_gutter_width (w, 1))
  373.  
  374. #define WINDOW_HEIGHT(w) ((w)->pixel_height)
  375. #define WINDOW_TEXT_HEIGHT(w) (WINDOW_TEXT_BOTTOM (w) - WINDOW_TEXT_TOP (w))
  376. #define WINDOW_WIDTH(w) ((w)->pixel_width)
  377. #define WINDOW_TEXT_WIDTH(w) (WINDOW_TEXT_RIGHT (w) - WINDOW_TEXT_LEFT (w))
  378.  
  379. #define WINDOW_HAS_MODELINE_P(w) (!NILP (w->has_modeline_p))
  380.  
  381. #define MODELINE_OFF_SHADOW_THICKNESS_ADJUSTED(win)        \
  382.  abs ((!WINDOW_HAS_MODELINE_P (win)                \
  383.        ? ((XINT (win->modeline_shadow_thickness) > 1)        \
  384.       ? XINT (win->modeline_shadow_thickness) - 1        \
  385.       : ((XINT (win->modeline_shadow_thickness) < -1)    \
  386.          ? XINT (win->modeline_shadow_thickness) + 1    \
  387.          : XINT (win->modeline_shadow_thickness)))        \
  388.        : XINT (win->modeline_shadow_thickness)))
  389.  
  390. #define MODELINE_SHADOW_THICKNESS(win)                \
  391.  (MODELINE_OFF_SHADOW_THICKNESS_ADJUSTED (win) > 10         \
  392.   ? 10                                \
  393.   : MODELINE_OFF_SHADOW_THICKNESS_ADJUSTED (win))
  394.  
  395. #endif /* emacs */
  396.  
  397. #endif /* _XEMACS_WINDOW_H_ */
  398.